X User Tools

home *** CD-ROM | disk | FTP | other *** search

/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / catn / entry.n < prev next >

Wrap

Text File | 1994-09-20 | 14.5 KB | 397 lines

entry(n) Tk Commands _________________________________________________________________ NAME entry - Create and manipulate entry widgets SYNOPSIS entry _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s? STANDARD OPTIONS background foreground insertWidth selectForeground| borderWidth insertBackground relieftextVariable| cursor insertBorderWidth scrollCommand | exportSelection insertOffTime selectBackground | font insertOnTime selectBorderWidth | See the ``options'' manual entry for details on the standard options. WIDGET-SPECIFIC OPTIONS Name: state | Class: State | Command-Line Switch:-state | || Specifies one of two states for the entry: normal or | disabled. If the entry is disabled then the value may | not be changed using widget commands and no insertion | cursor will be displayed, even if the input focus is in | the widget. Name: width Class: Width Command-Line Switch:-width Specifies an integer value indicating the desired width of the entry window, in average-size characters of the widget's font. _________________________________________________________________ DESCRIPTION The entry command creates a new window (given by the _p_a_t_h_- _N_a_m_e argument) and makes it into an entry widget. Addi- tional options, described above, may be specified on the command line or in the option database to configure aspects of the entry such as its colors, font, and relief. The entry command returns its _p_a_t_h_N_a_m_e argument. At the time this command is invoked, there must not exist a window named _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent must exist. An entry is a widget that displays a one-line text string and allows that string to be edited using widget commands Tk 1 entry(n) Tk Commands described below, which are typically bound to keystrokes and mouse actions. When first created, an entry's string is empty. A portion of the entry may be selected as described below. If an entry is exporting its selection (see the | exportSelection option), then it will observe the standard | X11 protocols for handling the selection; entry selections are available as type STRING. Entries also observe the standard Tk rules for dealing with the input focus. When an entry has the input focus it displays an _i_n_s_e_r_t_i_o_n _c_u_r_s_o_r to indicate where new characters will be inserted. Entries are capable of displaying strings that are too long to fit entirely within the widget's window. In this case, only a portion of the string will be displayed; commands described below may be used to change the view in the win- dow. Entries use the standard scrollCommand mechanism for interacting with scrollbars (see the description of the scrollCommand option for details). They also support scan- ning, as described below. WIDGET COMMAND The entry command creates a new Tcl command whose name is _p_a_t_h_N_a_m_e. This command may be used to invoke various opera- tions on the widget. It has the following general form: _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...? _O_p_t_i_o_n and the _a_r_gs determine the exact behavior of the com- mand. Many of the widget commands for entries take one or more indices as arguments. An index specifies a particular char- acter in the entry's string, in any of the following ways: _n_u_m_b_e_r Specifies the character as a numerical index, where 0 corresponds to the first character in the string. end Indicates the character just after the last one in the entry's string. This is equivalent to specifying a numerical index equal to the length of the entry's string. insert Indicates the character adjacent to and immedi- | ately following the insertion cursor. sel.first Indicates the first character in the selection. It is an error to use this form if the selection isn't in the entry window. sel.last Indicates the last character in the selection. It is an error to use this form if the selection Tk 2 entry(n) Tk Commands isn't in the entry window. @_n_u_m_b_e_r In this form, _n_u_m_b_e_r is treated as an x- coordinate in the entry's window; the character spanning that x-coordinate is used. For exam- ple, ``@0'' indicates the left-most character in the window. Abbreviations may be used for any of the forms above, e.g. ``e'' or ``sel.f''. In general, out-of-range indices are automatically rounded to the nearest legal value. The following commands are possible for entry widgets: _p_a_t_h_N_a_m_e configure ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...? Query or modify the configuration options of the widget. If no _o_p_t_i_o_n is specified, returns a list describing all of the available options for _p_a_t_h_N_a_m_e (see Tk_ConfigureInfo for information on the format of this list). If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then the command returns a list describing the one named option (this list will be identical to the correspond- ing sublist of the value returned if no _o_p_t_i_o_n is specified). If one or more _o_p_t_i_o_n-_v_a_l_u_e pairs are specified, then the command modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. _O_p_t_i_o_n may have any of the values accepted by the entry command. _p_a_t_h_N_a_m_e delete _f_i_r_s_t ?_l_a_s_t? Delete one or more elements of the entry. _F_i_r_s_t and _l_a_s_t are indices of of the first and last characters in the range to be deleted. If _l_a_s_t isn't specified it defaults to _f_i_r_s_t, i.e. a single character is deleted. This command returns an empty string. _p_a_t_h_N_a_m_e get Returns the entry's string. _p_a_t_h_N_a_m_e icursor _i_n_d_e_x Arrange for the insertion cursor to be displayed just | before the character given by _i_n_d_e_x. Returns an empty | string. _p_a_t_h_N_a_m_e index _i_n_d_e_x Returns the numerical index corresponding to _i_n_d_e_x. _p_a_t_h_N_a_m_e insert _i_n_d_e_x _s_t_r_i_n_g Insert the characters of _s_t_r_i_n_g just before the charac- ter indicated by _i_n_d_e_x. Returns an empty string. _p_a_t_h_N_a_m_e scan _o_p_t_i_o_n _a_r_g_s Tk 3 entry(n) Tk Commands This command is used to implement scanning on entries. It has two forms, depending on _o_p_t_i_o_n: _p_a_t_h_N_a_m_e scan mark _x Records _x and the current view in the entry win- dow; used in conjunction with later scan dragto commands. Typically this command is associated with a mouse button press in the widget. It returns an empty string. _p_a_t_h_N_a_m_e scan dragto _x This command computes the difference between its _x argument and the _x argument to the last scan mark command for the widget. It then adjusts the view left or right by 10 times the difference in x- coordinates. This command is typically associated with mouse motion events in the widget, to produce the effect of dragging the entry at high speed through the window. The return value is an empty string. _p_a_t_h_N_a_m_e select _o_p_t_i_o_n _a_r_g This command is used to adjust the selection within an entry. It has several forms, depending on _o_p_t_i_o_n: _p_a_t_h_N_a_m_e select adjust _i_n_d_e_x Locate the end of the selection nearest to the character given by _i_n_d_e_x, and adjust that end of the selection to be at _i_n_d_e_x (i.e including but not going beyond _i_n_d_e_x). The other end of the selection is made the anchor point for future select to commands. If the selection isn't currently in the entry, then a new selection is created to include the characters between _i_n_d_e_x and the most recent selection anchor point, inclusive. Returns an empty string. _p_a_t_h_N_a_m_e select clear Clear the selection if it is currently in this widget. If the selection isn't in this widget then the command has no effect. Returns an empty string. _p_a_t_h_N_a_m_e select from _i_n_d_e_x Set the selection anchor point to just before the character given by _i_n_d_e_x. Doesn't change the selection. Returns an empty string. _p_a_t_h_N_a_m_e select to _i_n_d_e_x Set the selection to consist of the elements from the anchor point to element _i_n_d_e_x, inclusive. The anchor point is determined by the most recent Tk 4 entry(n) Tk Commands select from or select adjust command in this widget. If the selection isn't in this widget then a new selection is created using the most recent anchor point specified for the widget. Returns an empty string. _p_a_t_h_N_a_m_e view _i_n_d_e_x Adjust the view in the entry so that element _i_n_d_e_x is at the left edge of the window. Returns an empty string. DEFAULT BINDINGS Tk automatically creates class bindings for entries that | give them the following default behavior: | [1] || Clicking mouse button 1 in an entry positions the | insertion cursor just before the character underneath | the mouse cursor and sets the input focus to this | widget. | [2] || Dragging with mouse button 1 strokes out a selection | between the insertion cursor and the character under | the mouse. | [3] || The ends of the selection can be adjusted by dragging | with mouse button 1 while the shift key is down; this | will adjust the end of the selection that was nearest | to the mouse cursor when button 1 was pressed. | [4] || The view in the entry can be adjusted by dragging with | mouse button 2. | [5] || If the input focus is in an entry widget and characters | are typed on the keyboard, the characters are inserted | just before the insertion cursor. | [6] || Control-h and the Backspace and Delete keys erase the | character just before the insertion cursor. | [7] || Control-w erases the word just before the insertion | cursor. | [8] || Control-u clears the entry to an empty string. | Tk 5 entry(n) Tk Commands [9] || Control-v inserts the current selection just before the | insertion cursor. | [10] || Control-d deletes the selected characters; an error | occurs if the selection is not in this widget. | If the entry is disabled using the state option, then the | entry's view can still be adjusted and text in the entry can | still be selected, but no insertion cursor will be displayed | and no text modifications will take place. | The behavior of entries can be changed by defining new bind- | ings for individual widgets or by redefining the class bind- | ings. KEYWORDS entry, widget Tk 6